home *** CD-ROM | disk | FTP | other *** search
/ Aminet 8 / Aminet 8 (1995)(GTI - Schatztruhe)[!][Oct 1995].iso / Aminet / comm / fido / jm950728.lha / docs / inboundnotify.doc < prev    next >
Text File  |  1995-04-01  |  4KB  |  85 lines
  1.  
  2. To greatly ease the configuration and use of Trapdoor style file request handlers
  3. in JamMail, a brand new system was created.  It replaces the XfreqSH variables,
  4. and the XfreqSH command line menus completely.  This new system is also used for
  5. the User Freq/Grab command line.
  6.  
  7. File request handling is now directly part of the Inbound processing options.
  8.  
  9. Each Inbound Process Entry has 3 options, the command string, the filename
  10. pattern, and an Asynchronous Launch Toggle.
  11.  
  12. A FileName pattern of "#?.REQ" would be used to launch a file request server.  I
  13. would recommend that if you are planning on supporting File requests, that it be
  14. the first entry listed.
  15.  
  16. The Command string supports most of the TrapDoor % variable substitutions as well
  17. as a number of additional JamMail variables.
  18.  
  19. The following variables may be used anywhere in the Inbound Notify command string.
  20.  
  21.  
  22.  TD     JamMail Var                 Description
  23. ----  ---------------   -------------------------------------
  24.  
  25.  %b = $(Locked)       = Locked Baud Rate
  26.  %B = $(Baud)         = Connect Baud Rate
  27.  %C = $(ConnectMsg)   = Actual Connect message from modem
  28.  %s = $(Device)       = Serial device
  29.  %u = $(Unit)         = Serial Unit
  30.  %f = $(Flags)        = Serial Flags
  31.  %Z = $(Remote.Zone)  = Remote Fido Systems Zone
  32.  %N = $(Remote.Net)   = Remote Fido Systems Net
  33.  %F = $(Remote.Node)  = Remote Fido Systems Node
  34.  %P = $(Remote.Point) = Remote Fido Systems Point
  35.  %n = $(Remote.Zone):$(Remote.Net)/$(Remote.Node).$(Remote.Point)@$(Remote.Domain)
  36.                       = Remote Fido Systems Address (4d@Domain).
  37.  %S = $(Remote.Sysop) = Remote Fido Systems Sysop
  38.  %I = $(Inbound)      = FidoNet Inbound Dir
  39.  %O = $(Outbound)     = FidoNet Outbound Dir
  40.  %i = $(infile)       = Inbound FileName (Full path as stored on disk)
  41.  %o = $(rlofile)      = Outbound File from File Request Handler
  42.  %p = $(PubScreenName)= PublicScreen Name
  43.  
  44.  
  45.       $(cps)          = Inbound Files Transfer Rate CPS   = "unknown%" if 0 seconds used
  46.       $(cpsp)         = Inbound Files Transfer Rate (% of Baud Rate)
  47.  
  48.       $(Remote.Sitename)= Remote Fido System Name
  49.       $(Remote.Address)= Remote Fido Systems 5d Address (Domain#Zone:Net/Node.Point)
  50.       $(Remote.Password)= Remote Fido Systems Password (if one used)
  51.  
  52.       $(Remote.Mailer)= Remote EMSI Mailers ID string
  53.       $(Remote.Compat)= Remote EMSI Mailers Compatibility Strings
  54.       $(Remote.Phone) = Remote EMSI Mailers Given Phone Number
  55.       $(PhoneNumber)  = Phone number dialed (outbound only)
  56.  
  57.       $(remfile)      = Origional Inbound Filename.
  58.       $(Line)         = System Line Number (as configured in Line->Other Menu)
  59.  
  60.       $(Host.Serial)  = JamMail Version String
  61.       $(Host.Phone)   = Line Phone Number (as configured in Line->Other Menu)
  62.       $(Modem)        = Modem Brand/Speed String (as configured in Line->Modem Menu)
  63.  
  64.  
  65. The Asynchronous Launch Option is Quite usefull in situations where speed is
  66. relevent (like handling File Requests).  If the command you are launching is
  67. capable of being launched this way, you should always do it.  Some file
  68. request handlers may not be able to operate this way.
  69.  
  70. The primary advantage of launching a request handler this way, is that the system
  71. can start sending files to the user as soon as possible instead of waiting for
  72. all of them to be found.
  73.  
  74. There are two included default InboundNotify config options in the system.  A
  75. configuration for file requests and User Grabs to be handled by FFRS using the
  76. regular TrapDoor command string it gives in its documentation, and a second
  77. entry, which I use to move UUCP style RFC Mail batches transfered in FidoNet
  78. sessions, into the UUSPOOL: directory using JamMail variables.
  79.  
  80. Those of you still wanting to use XfreqSH (for whatever reason), may still do
  81. so, by putting the XfreqSH command line in the command string here, disabling
  82. Async launching and replacing the contents of the XfreqSH variables with their
  83. real values (as had been configured in the old menu system).
  84.  
  85.